Operation Document.RemoveEntryOfMultivaluedProperty (Remove Entry Of Multivalued Property)

In component org.nuxeo.ecm.core.automation.coreContrib

Description

Remove the first entry of the giving value in the multivalued xpath, does nothing if does not exist: if 'is Remove All' is check, all entry instance in the list.

if not will remove just the first one found

Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.

Operation id	Document.RemoveEntryOfMultivaluedProperty
Aliases	`RemoveEntryOfMultivaluedProperty`
Category	Document
Label	Remove Entry Of Multivalued Property
Requires
Since

Parameters

Name	Type	Required	Default value
value	serializable	yes
xpath	string	yes
is Remove All	boolean	no	true
save	boolean	no	true

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.document.RemoveEntryOfMultiValuedProperty
Contributing Component	org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.RemoveEntryOfMultivaluedProperty",
  "aliases" : [ "RemoveEntryOfMultivaluedProperty" ],
  "label" : "Remove Entry Of Multivalued Property",
  "category" : "Document",
  "requires" : null,
  "description" : "Remove the first entry of the giving value in the multivalued xpath, does nothing if does not exist: <ul<li>if 'is Remove All' is check, all entry instance in the list.</li><li>if not will remove just the first one found</li></ul><p>Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.</p>",
  "url" : "Document.RemoveEntryOfMultivaluedProperty",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "value",
    "description" : null,
    "type" : "serializable",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "is Remove All",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ]
}